Send Binary SMS
This API is used to send data, such as small files, to a subscriber, rather than simply plain text.
|
HTTP URL |
|
|---|---|
|
POST |
/api/v2/subscriber/ |
NOTE: All {type} and {value} pairs, define the search criteria. Valid {type} ENUMs are: ‘imsi’, ‘iccid’, ‘msisdn’, ‘imei’.
API Request
Request Structure
|
Parameter |
Type |
M/O/CM |
Description |
|---|---|---|---|
|
message |
String |
M |
Message verbiage |
|
dataCoding |
Numeric |
O |
Data coding valid values as defined in 3GPP TS 23.038 |
|
esmClass |
Numeric |
O |
esm_Class indicates special message attributes. Valid values as defined in SMPP Specification document. |
|
protocolId |
Numeric |
O |
TP-Protocol Identifier. Valid values as defined in 3GPP TS 23.040 |
|
priorityFlag |
Numeric |
O |
Allows prioritizing the message via a priority level. Valid values as defined in SMPP Specification document. |
|
expiration |
Numeric |
O |
Set Store & Forward requested time (seconds) when the device is not reachable. Minimum: 120 seconds Maximum: 2678400 seconds Default (if not populated): 7200 seconds |
API Response
Response Structure
|
Parameter |
Type |
M/O/CM |
Description |
|---|---|---|---|
|
errorCode |
String |
O |
Failure code. |
|
errorMessage |
String |
O |
Failure message. |
|
content |
Object |
O |
Array of main response body object displayed when an API call was successful. For a failure, it will be empty. |
|
pageable |
Object |
O |
Paging information object displayed when an API call was successful. For a failure, it will be empty. |
Content data objects
|
Element |
Type |
M/O/CM |
Description |
|---|---|---|---|
|
messageID |
UUID |
M |
SMS delivery ID for delivery notification |
Pageable data objects
|
Element |
Type |
M/O/CM |
Description |
|---|---|---|---|
|
page |
Numeric |
M |
Page number |
|
size |
Numeric |
M |
Page size. Number of requested elements per page |
|
totalPages |
Numeric |
M |
Total amount of available pages per requested page size |
|
totalElements |
Numeric |
M |
Total amount of retrieved elements |
Error Codes
In addition to the general success and failure codes, the following error codes are possible.
|
Code |
Message |
|---|---|
|
GLOBAL_1001 |
Service unavailable. Please try again |
|
GLOBAL_1006 |
Invalid SMSC |
|
SUBSCRIBER_1002 |
Subscriber does not exist |
|
SUBSCRIBER_1012 |
Failed to send SMS |
Examples
Request Body
{
"message": "hello",
"dataCoding": 0,
"esmClass": 0,
"protocolId": 0,
"priorityFlag": 0,
"expiration": 3000
}Response Body: Success ACK
{
"errorCode": "",
"errorMessage": "",
"content": [
{
"messageId": "ff74dca6-8e7f-4b85-a42b-13860913b370"
}
],
"pageable": {
"page": 0,
"size": 10,
"totalPages": 1,
"totalElements": 1
}
}